RequestPredicates.SubPathServerRequestWrapper

java.lang.Object
- org.springframework.web.reactive.function.server.RequestPredicates.SubPathServerRequestWrapper

All Implemented Interfaces:: ServerRequest

Enclosing class:: RequestPredicates

private static class RequestPredicates.SubPathServerRequestWrapper
extends java.lang.Object
implements ServerRequest

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class RequestPredicates.SubPathServerRequestWrapper.SubPathContainer
- Nested classes/interfaces inherited from interface org.springframework.web.reactive.function.server.ServerRequest
  ServerRequest.Headers

Nested Classes
Modifier and Type	Class and Description
`private static class`	`RequestPredicates.SubPathServerRequestWrapper.SubPathContainer`

Field Summary

Fields
Modifier and Type Field and Description

private ServerRequest request

private PathContainer subPathContainer

Fields
Modifier and Type	Field and Description
`private ServerRequest`	`request`
`private PathContainer`	`subPathContainer`

Constructor Summary

Constructors
Constructor and Description

SubPathServerRequestWrapper(ServerRequest request, PathPattern.PathRemainingMatchInfo info)

Constructors
Constructor and Description
`SubPathServerRequestWrapper(ServerRequest request, PathPattern.PathRemainingMatchInfo info)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Optional<java.lang.Object>`	`attribute(java.lang.String name)` Return the request attribute value if present.
`java.util.Map<java.lang.String,java.lang.Object>`	`attributes()` Return a mutable map of request attributes.
`<T> T`	`body(BodyExtractor<T,? super ServerHttpRequest> extractor)` Extract the body with the given `BodyExtractor`.
`<T> T`	`body(BodyExtractor<T,? super ServerHttpRequest> extractor, java.util.Map<java.lang.String,java.lang.Object> hints)` Extract the body with the given `BodyExtractor` and hints.
`<T> <any>`	`bodyToFlux(java.lang.Class<? extends T> elementClass)` Extract the body to a `Flux`.
`<T> <any>`	`bodyToFlux(ParameterizedTypeReference<T> typeReference)` Extract the body to a `Flux`.
`<T> <any>`	`bodyToMono(java.lang.Class<? extends T> elementClass)` Extract the body to a `Mono`.
`<T> <any>`	`bodyToMono(ParameterizedTypeReference<T> typeReference)` Extract the body to a `Mono`.
`MultiValueMap<java.lang.String,HttpCookie>`	`cookies()` Return the cookies of this request.
`ServerRequest.Headers`	`headers()` Return the headers of this request.
`HttpMethod`	`method()` Return the HTTP method.
`java.lang.String`	`methodName()` Return the name of the HTTP method.
`java.lang.String`	`path()` Return the request path.
`PathContainer`	`pathContainer()` Return the request path as `PathContainer`.
`java.lang.String`	`pathVariable(java.lang.String name)` Return the path variable with the given name, if present.
`java.util.Map<java.lang.String,java.lang.String>`	`pathVariables()` Return all path variables for this request.
`<any>`	`principal()` Return the authenticated user for the request, if any.
`java.util.Optional<java.lang.String>`	`queryParam(java.lang.String name)` Return the first query parameter with the given name, if present.
`MultiValueMap<java.lang.String,java.lang.String>`	`queryParams()` Return all query parameters for this request.
`<any>`	`session()` Return the web session for this request.
`java.lang.String`	`toString()`
`java.net.URI`	`uri()` Return the request URI.
`UriBuilder`	`uriBuilder()` Return a `UriBuilderComponents` from the URI associated with this `ServerRequest`, while also overlaying with values from the headers "Forwarded" (RFC 7239), or "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" if "Forwarded" is not found.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.web.reactive.function.server.ServerRequest
create

- Field Detail
  - request
```
private final ServerRequest request
```
  - subPathContainer
```
private final PathContainer subPathContainer
```
- Constructor Detail
  - SubPathServerRequestWrapper
```
public SubPathServerRequestWrapper(ServerRequest request,
                                   PathPattern.PathRemainingMatchInfo info)
```
- Method Detail
  - method
```
public HttpMethod method()
```
    Description copied from interface: ServerRequest
    
    Return the HTTP method.
    
    Specified by:
    
    method in interface ServerRequest
    
    Returns:
    
    the HTTP method as an HttpMethod enum value, or null if not resolvable (e.g. in case of a non-standard HTTP method)
  - methodName
```
public java.lang.String methodName()
```
    Description copied from interface: ServerRequest
    
    Return the name of the HTTP method.
    
    Specified by:
    
    methodName in interface ServerRequest
    
    Returns:
    
    the HTTP method as a String
  - uri
```
public java.net.URI uri()
```
    Description copied from interface: ServerRequest
    
    Return the request URI.
    
    Specified by:
    
    uri in interface ServerRequest
  - uriBuilder
```
public UriBuilder uriBuilder()
```
    Description copied from interface: ServerRequest
    
    Return a UriBuilderComponents from the URI associated with this ServerRequest, while also overlaying with values from the headers "Forwarded" (RFC 7239), or "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" if "Forwarded" is not found.
    
    Specified by:
    
    uriBuilder in interface ServerRequest
    
    Returns:
    
    a URI builder
  - path
```
public java.lang.String path()
```
    Description copied from interface: ServerRequest
    
    Return the request path.
    
    Specified by:
    
    path in interface ServerRequest
  - pathContainer
```
public PathContainer pathContainer()
```
    Description copied from interface: ServerRequest
    
    Return the request path as PathContainer.
    
    Specified by:
    
    pathContainer in interface ServerRequest
  - headers
```
public ServerRequest.Headers headers()
```
    Description copied from interface: ServerRequest
    
    Return the headers of this request.
    
    Specified by:
    
    headers in interface ServerRequest
  - cookies
```
public MultiValueMap<java.lang.String,HttpCookie> cookies()
```
    Description copied from interface: ServerRequest
    
    Return the cookies of this request.
    
    Specified by:
    
    cookies in interface ServerRequest
  - body
```
public <T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor)
```
    Description copied from interface: ServerRequest
    
    Extract the body with the given BodyExtractor.
    
    Specified by:
    
    body in interface ServerRequest
    
    Type Parameters:
    
    T - the type of the body returned
    
    Parameters:
    
    extractor - the BodyExtractor that reads from the request
    
    Returns:
    
    the extracted body
    
    See Also:
    
    ServerRequest.body(BodyExtractor, Map)
  - body
```
public <T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor,
                  java.util.Map<java.lang.String,java.lang.Object> hints)
```
    Description copied from interface: ServerRequest
    
    Extract the body with the given BodyExtractor and hints.
    
    Specified by:
    
    body in interface ServerRequest
    
    Type Parameters:
    
    T - the type of the body returned
    
    Parameters:
    
    extractor - the BodyExtractor that reads from the request
    
    hints - the map of hints like Jackson2CodecSupport.JSON_VIEW_HINT to use to customize body extraction
    
    Returns:
    
    the extracted body
  - bodyToMono
```
public <T> <any> bodyToMono(java.lang.Class<? extends T> elementClass)
```
    Description copied from interface: ServerRequest
    
    Extract the body to a Mono.
    
    Specified by:
    
    bodyToMono in interface ServerRequest
    
    Type Parameters:
    
    T - the element type
    
    Parameters:
    
    elementClass - the class of element in the Mono
    
    Returns:
    
    the body as a mono
  - bodyToMono
```
public <T> <any> bodyToMono(ParameterizedTypeReference<T> typeReference)
```
    Description copied from interface: ServerRequest
    
    Extract the body to a Mono.
    
    Specified by:
    
    bodyToMono in interface ServerRequest
    
    Type Parameters:
    
    T - the element type
    
    Parameters:
    
    typeReference - a type reference describing the expected response request type
    
    Returns:
    
    a mono containing the body of the given type T
  - bodyToFlux
```
public <T> <any> bodyToFlux(java.lang.Class<? extends T> elementClass)
```
    Description copied from interface: ServerRequest
    
    Extract the body to a Flux.
    
    Specified by:
    
    bodyToFlux in interface ServerRequest
    
    Type Parameters:
    
    T - the element type
    
    Parameters:
    
    elementClass - the class of element in the Flux
    
    Returns:
    
    the body as a flux
  - bodyToFlux
```
public <T> <any> bodyToFlux(ParameterizedTypeReference<T> typeReference)
```
    Description copied from interface: ServerRequest
    
    Extract the body to a Flux.
    
    Specified by:
    
    bodyToFlux in interface ServerRequest
    
    Type Parameters:
    
    T - the element type
    
    Parameters:
    
    typeReference - a type reference describing the expected request body type
    
    Returns:
    
    a flux containing the body of the given type T
  - attribute
```
public java.util.Optional<java.lang.Object> attribute(java.lang.String name)
```
    Description copied from interface: ServerRequest
    
    Return the request attribute value if present.
    
    Specified by:
    
    attribute in interface ServerRequest
    
    Parameters:
    
    name - the attribute name
    
    Returns:
    
    the attribute value
  - attributes
```
public java.util.Map<java.lang.String,java.lang.Object> attributes()
```
    Description copied from interface: ServerRequest
    
    Return a mutable map of request attributes.
    
    Specified by:
    
    attributes in interface ServerRequest
    
    Returns:
    
    the request attributes
  - queryParam
```
public java.util.Optional<java.lang.String> queryParam(java.lang.String name)
```
    Description copied from interface: ServerRequest
    
    Return the first query parameter with the given name, if present.
    
    Specified by:
    
    queryParam in interface ServerRequest
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value
  - queryParams
```
public MultiValueMap<java.lang.String,java.lang.String> queryParams()
```
    Description copied from interface: ServerRequest
    
    Return all query parameters for this request.
    
    Specified by:
    
    queryParams in interface ServerRequest
  - pathVariable
```
public java.lang.String pathVariable(java.lang.String name)
```
    Description copied from interface: ServerRequest
    
    Return the path variable with the given name, if present.
    
    Specified by:
    
    pathVariable in interface ServerRequest
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the variable value
  - pathVariables
```
public java.util.Map<java.lang.String,java.lang.String> pathVariables()
```
    Description copied from interface: ServerRequest
    
    Return all path variables for this request.
    
    Specified by:
    
    pathVariables in interface ServerRequest
  - session
```
public <any> session()
```
    Description copied from interface: ServerRequest
    
    Return the web session for this request. Always guaranteed to return an instance either matching to the session id requested by the client, or with a new session id either because the client did not specify one or because the underlying session had expired. Use of this method does not automatically create a session.
    
    Specified by:
    
    session in interface ServerRequest
  - principal
```
public <any> principal()
```
    Description copied from interface: ServerRequest
    
    Return the authenticated user for the request, if any.
    
    Specified by:
    
    principal in interface ServerRequest
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class RequestPredicates.SubPathServerRequestWrapper

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.web.reactive.function.server.ServerRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.web.reactive.function.server.ServerRequest

Field Detail

request

subPathContainer

Constructor Detail

SubPathServerRequestWrapper

Method Detail

method

methodName

uri

uriBuilder

path

pathContainer

headers

cookies

body

body

bodyToMono

bodyToMono

bodyToFlux

bodyToFlux

attribute

attributes

queryParam

queryParams

pathVariable

pathVariables

session

principal

toString